{
"cells": [
{
"cell_type": "markdown",
"id": "ad441e7b",
"metadata": {},
"source": [
"# Overriding a Mechanism in MusicBox\n",
"\n",
"Each MusicBox instance can only work with one mechanism at a time. To change the chemical system, you can load a new mechanism using the `load_mechanism()` method, which will replace the existing one. This tutorial demonstrates how to switch from one mechanism to a completely different chemical system."
]
},
{
"cell_type": "markdown",
"id": "cad0ad50",
"metadata": {},
"source": [
"## 1. Creating the Mechanism and Box Model\n",
"\n",
"This is simply a copy of the first half of the Basic Workflow Tutorial to set up the mechanism for overriding."
]
},
{
"cell_type": "code",
"execution_count": 1,
"id": "f0cb3f6f",
"metadata": {},
"outputs": [],
"source": [
"from acom_music_box import MusicBox\n",
"import musica.mechanism_configuration as mc\n",
"import matplotlib.pyplot as plt\n",
"\n",
"# Create species and phase for the reactions\n",
"X = mc.Species(name=\"X\")\n",
"Y = mc.Species(name=\"Y\")\n",
"Z = mc.Species(name=\"Z\")\n",
"species = {\"X\": X, \"Y\": Y, \"Z\": Z}\n",
"gas = mc.Phase(name=\"gas\", species=list(species.values()))\n",
"\n",
"# Create the Arrhenius reactions\n",
"reaction1 = mc.Arrhenius(name=\"X->Y\", A=4.0e-3, C=50, reactants=[species[\"X\"]], products=[species[\"Y\"]], gas_phase=gas)\n",
"reaction2 = mc.Arrhenius(name=\"Y->Z\", A=4.0e-3, C=50, reactants=[species[\"Y\"]], products=[species[\"Z\"]], gas_phase=gas)\n",
"rxns = {\"X->Y\": reaction1, \"Y->Z\": reaction2}\n",
"\n",
"# Create the mechanism that is defined by the species, phases, and reactions\n",
"mechanism = mc.Mechanism(\n",
" name=\"tutorial_mechanism\", \n",
" species=list(species.values()), \n",
" phases=[gas], \n",
" reactions=list(rxns.values()))\n",
"\n",
"# Create the box model that contains the mechanism\n",
"box_model = MusicBox()\n",
"box_model.load_mechanism(mechanism)"
]
},
{
"cell_type": "markdown",
"id": "017f8fa1",
"metadata": {},
"source": [
"## 2. Overriding with a New Mechanism\n",
"\n",
"Now we'll completely replace the mechanism with a different chemical reactions. Instead of the Arrhenius reactions system, we'll create quantum tunneling reactions.\n",
"\n",
"This demonstrates how to override a mechanism by:\n",
"- Using different species (G and H instead of X, Y, Z)\n",
"- Using quantum tunneling reactions\n",
"\n",
"Here's the code to define and load the new mechanism:"
]
},
{
"cell_type": "code",
"execution_count": 2,
"id": "6c840133",
"metadata": {},
"outputs": [],
"source": [
"# Create new species and phase\n",
"G = mc.Species(name=\"G\")\n",
"H = mc.Species(name=\"H\")\n",
"species = {\"G\": G, \"H\": H}\n",
"\n",
"gas = mc.Phase(name=\"gas\", species=list(species.values()))\n",
"\n",
"# Create the reactions and overwrite the variables\n",
"reaction1 = mc.Tunneling(name=\"G->H\", A=2.0e-3, B=2, C=50, reactants=[species[\"G\"]], products=[species[\"H\"]], gas_phase=gas)\n",
"reaction2 = mc.Tunneling(name=\"H->G\", A=9.0e-3, B=2, C=50, reactants=[species[\"H\"]], products=[species[\"G\"]], gas_phase=gas)\n",
"rxns = {\"G->H\": reaction1, \"H->G\": reaction2}\n",
"\n",
"\n",
"# Create the new mechanism with the newly defiend reactions\n",
"mechanism = mc.Mechanism(\n",
" name=\"new_mechanism\", \n",
" species=list(species.values()), \n",
" phases=[gas], \n",
" reactions=list(rxns.values())\n",
")\n",
"\n",
"# Override the previous mechanism by loading the new one\n",
"box_model.load_mechanism(mechanism)"
]
},
{
"cell_type": "markdown",
"id": "62878d04",
"metadata": {},
"source": [
"## 3. Running and Visualizing the New Box Model\n",
"\n",
"Now we can run the simulation with our new reversible mechanism. Notice that we're using the species names \"G\" and \"H\" instead of \"X\", \"Y\", and \"Z\" from the previous mechanism.\n",
"\n",
"The rest of this code is adapted from the Basic Workflow Tutorial. For detailed explanations of each step, refer to that tutorial:"
]
},
{
"cell_type": "code",
"execution_count": 3,
"id": "c2f1f497",
"metadata": {},
"outputs": [
{
"name": "stderr",
"output_type": "stream",
"text": [
" "
]
},
{
"data": {
"text/html": [
"\n",
"\n",
"
\n",
" \n",
" \n",
" time.s \n",
" ENV.temperature.K \n",
" ENV.pressure.Pa \n",
" ENV.air number density.mol m-3 \n",
" CONC.G.mol m-3 \n",
" CONC.H.mol m-3 \n",
" \n",
" \n",
" \n",
" \n",
" 0 \n",
" 0.0 \n",
" 298.15 \n",
" 101325.0 \n",
" 40.874045 \n",
" 2.500000 \n",
" 5.000000 \n",
" \n",
" \n",
" 1 \n",
" 20.0 \n",
" 298.15 \n",
" 101325.0 \n",
" 40.874045 \n",
" 3.213819 \n",
" 4.286181 \n",
" \n",
" \n",
" 2 \n",
" 40.0 \n",
" 298.15 \n",
" 101325.0 \n",
" 40.874045 \n",
" 3.787516 \n",
" 3.712484 \n",
" \n",
" \n",
" 3 \n",
" 60.0 \n",
" 298.15 \n",
" 101325.0 \n",
" 40.874045 \n",
" 4.248595 \n",
" 3.251405 \n",
" \n",
" \n",
" 4 \n",
" 80.0 \n",
" 298.15 \n",
" 101325.0 \n",
" 40.874045 \n",
" 4.619165 \n",
" 2.880835 \n",
" \n",
" \n",
" 5 \n",
" 100.0 \n",
" 298.15 \n",
" 101325.0 \n",
" 40.874045 \n",
" 4.916991 \n",
" 2.583009 \n",
" \n",
" \n",
" 6 \n",
" 120.0 \n",
" 310.00 \n",
" 100100.0 \n",
" 38.836331 \n",
" 5.156409 \n",
" 2.343591 \n",
" \n",
" \n",
" 7 \n",
" 140.0 \n",
" 310.00 \n",
" 100100.0 \n",
" 38.836331 \n",
" 5.348819 \n",
" 2.151181 \n",
" \n",
" \n",
" 8 \n",
" 160.0 \n",
" 310.00 \n",
" 100100.0 \n",
" 38.836331 \n",
" 5.503449 \n",
" 1.996551 \n",
" \n",
" \n",
" 9 \n",
" 180.0 \n",
" 310.00 \n",
" 100100.0 \n",
" 38.836331 \n",
" 5.627719 \n",
" 1.872281 \n",
" \n",
" \n",
" 10 \n",
" 200.0 \n",
" 310.00 \n",
" 100100.0 \n",
" 38.836331 \n",
" 5.727589 \n",
" 1.772411 \n",
" \n",
" \n",
"
\n",
"
"
]
},
"metadata": {},
"output_type": "display_data"
}
],
"source": [
"# Set the conditions of the box model at time = 0 s\n",
"box_model.set_condition(\n",
" time=0,\n",
" temperature=298.15, # Units: Kelvin (K)\n",
" pressure=101325.0, # Units: Pascals (Pa)\n",
" concentrations={ # Units: mol/m^3\n",
" \"G\": 2.5,\n",
" \"H\": 5.0,\n",
" }\n",
")\n",
"\n",
"# Set the box model conditions at the defined time\n",
"box_model.set_condition(\n",
" time=100.0, # Units: Seconds (s)\n",
" temperature=310.0, # Units: Kelvin (K)\n",
" pressure=100100.0 # Units: Pascals (Pa)\n",
")\n",
"\n",
"# Set the additional configuration options for the box model\n",
"box_model.box_model_options.simulation_length = 200 # Units: Seconds (s)\n",
"box_model.box_model_options.chem_step_time = 1 # Units: Seconds (s)\n",
"box_model.box_model_options.output_step_time = 20 # Units: Seconds (s)\n",
"\n",
"df = box_model.solve()\n",
"display(df)\n",
"df.plot(x='time.s', y=['CONC.G.mol m-3', 'CONC.H.mol m-3'], title='Concentration over time', ylabel='Concentration (mol m-3)', xlabel='Time (s)')\n",
"plt.show()"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "musica",
"language": "python",
"name": "musica"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.14.2"
}
},
"nbformat": 4,
"nbformat_minor": 5
}